Docstring, variable name, formatting updates to IDEX L1 #799
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bourque
added
Ins: IDEX
bourque
commented
Aug 29, 2024
Comment on lines
+28
to
+37
| # Create a large dictionary of values from the FPGA header that need to be | ||
| # captured into the CDF file. They are lumped together because they share | ||
| # similar attributes. | ||
| # Notes about the variables are set here, acting as comments and will also be | ||
| # placed into the CDF in the VAR_NOTES attribute. | ||
| TRIGGER_DESCRIPTION = namedtuple( | ||
| "TRIGGER_DESCRIPTION", | ||
| ["name", "packet_name"], | ||
| ) | ||
| TRIGGER_DESCRIPTION_DICT = { |
There was a problem hiding this comment.
Moved this to the top of the file and made them ALL_CAPS since they are treated as global variables
tech3371
approved these changes
Aug 30, 2024
Comment on lines
13
to
25
| @pytest.fixture(scope="session") | ||
| def decom_test_data(): | ||
| def decom_test_data() -> xr.Dataset: | ||
| """Return a ``xarray`` dataset containing test data. | ||
|
|
||
| Returns | ||
| ------- | ||
| dataset : xarray.Dataset | ||
| A ``xarray`` dataset containing the test data | ||
| """ | ||
| test_file = Path( | ||
| f"{imap_module_directory}/tests/idex/imap_idex_l0_raw_20230725_v001.pkts" | ||
| ) | ||
| return PacketParser(test_file, "001") | ||
| return PacketParser(test_file, "001").data |
There was a problem hiding this comment.
Many of us have moved function that's shared across tests into tests/<instrument>/conftest.py. Can you do similar here?
bourque
commented
Sep 3, 2024
| } # fmt: skip | ||
|
|
||
|
|
||
| def get_idex_attrs(data_version: str) -> ImapCdfAttributes: |
There was a problem hiding this comment.
Moved this function to below all of the Class definitions
| @@ -123,34 +104,30 @@ class PacketParser: | |||
| data_version : str | |||
| The version of the data product being created. | |||
|
|
|||
| Methods | |||
| ------- | |||
| TODO : Add method to generate quicklook plots | |||
There was a problem hiding this comment.
Moved this TODO to the top of the file
| _calc_high_sample_resolution(num_samples) | ||
| parse_packet(packet) | ||
| Calculate the resolution of high samples. | ||
| _populate_bit_strings(packet) |
There was a problem hiding this comment.
Renamed parse_packet to _populate_bit_strings to be more explicit about what the method is doing. Also the words "parse" and "packet" are used a lot elsewhere so it could get confusing.
Comment on lines
13
to
25
| @pytest.fixture(scope="session") | ||
| def decom_test_data(): | ||
| def decom_test_data() -> xr.Dataset: | ||
| """Return a ``xarray`` dataset containing test data. | ||
|
|
||
| Returns | ||
| ------- | ||
| dataset : xarray.Dataset | ||
| A ``xarray`` dataset containing the test data | ||
| """ | ||
| test_file = Path( | ||
| f"{imap_module_directory}/tests/idex/imap_idex_l0_raw_20230725_v001.pkts" | ||
| ) | ||
| return PacketParser(test_file, "001") | ||
| return PacketParser(test_file, "001").data |
laspsandoval
pushed a commit
to laspsandoval/imap_processing
that referenced
this pull request
Sep 4, 2024
…-Operations-Center#799) * Various updates to docstrings, variable names, formatting * Moved pytest fixture that returns test data to conftest.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes various updates to docstrings, variable names, code organization, etc. to just make things a bit more readable and consistent in the IDEX L1 code (in my opinion!)